home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / MrmFetchIconLiteral.z / MrmFetchIconLiteral
Text File  |  1998-10-30  |  7KB  |  133 lines
  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll - Fetches an icon literal from a
  10.           hierarchy
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Mrm/MrmPublic.h>
  14.           CCCCaaaarrrrddddiiiinnnnaaaallll MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll(
  15.           MMMMrrrrmmmmHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd,
  16.           SSSSttttrrrriiiinnnngggg iiiinnnnddddeeeexxxx,
  17.           SSSSccccrrrreeeeeeeennnn ****ssssccccrrrreeeeeeeennnn,
  18.           DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,
  19.           PPPPiiiixxxxeeeellll ffffggggppppiiiixxxx,
  20.           PPPPiiiixxxxeeeellll bbbbggggppppiiiixxxx,
  21.           PPPPiiiixxxxmmmmaaaapppp ****ppppiiiixxxxmmmmaaaapppp);
  22.  
  23.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  24.           This page documents Motif 2.1.
  25.  
  26.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  27.           The MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallllfunction fetches an icon literal from
  28.           an MRM hierarchy and converts the icon literal to an X
  29.           pixmap.
  30.  
  31.           _h_i_e_r_a_r_c_h_y__i_d
  32.                     Specifies the ID of the UID hierarchy that
  33.                     contains the specified icon literal.  The
  34.                     _h_i_e_r_a_r_c_h_y__i_d was returned in a previous call to
  35.                     MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy.
  36.  
  37.           _i_n_d_e_x     Specifies the UIL name of the icon literal to
  38.                     fetch.
  39.  
  40.           _s_c_r_e_e_n    Specifies the screen used for the pixmap.  The
  41.                     _s_c_r_e_e_nargument specifies a pointer to the Xlib
  42.                     structure SSSSccccrrrreeeeeeeennnn, which contains the information
  43.                     about that screen and is linked to the
  44.                     DDDDiiiissssppppllllaaaayyyystructure.  For more information on the
  45.                     DDDDiiiissssppppllllaaaayyyyand SSSSccccrrrreeeeeeeennnnstructures, see the Xlib function
  46.                     XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyyand the associated screen information
  47.                     macros.
  48.  
  49.           _d_i_s_p_l_a_y   Specifies the display used for the pixmap.  The
  50.                     _d_i_s_p_l_a_yargument specifies the connection to the X
  51.                     server.  For more information on the DDDDiiiissssppppllllaaaayyyy
  52.                     structure, see the Xlib function XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy.
  53.  
  54.           _f_g_p_i_x     Specifies the foreground color for the pixmap.
  55.  
  56.           _b_g_p_i_x     Specifies the background color for the pixmap.
  57.  
  58.           _p_i_x_m_a_p    Returns the resulting X pixmap value.  The
  59.                     function allocates space for this pixmap.  The
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     application is responsible for managing the
  75.                     allocated space.  The application can recover the
  76.                     allocated space by calling XXXXmmmmDDDDeeeessssttttrrrrooooyyyyPPPPiiiixxxxmmmmaaaapppp.
  77.  
  78.      RRRREEEETTTTUUUURRRRNNNN
  79.           This function returns one of the following status return
  80.           constants:
  81.  
  82.           MMMMrrrrmmmmSSSSUUUUCCCCCCCCEEEESSSSSSSS
  83.                     The function executed successfully.
  84.  
  85.           MMMMrrrrmmmmBBBBAAAADDDD____HHHHIIIIEEEERRRRAAAARRRRCCCCHHHHYYYY
  86.                     The hierarchy ID was invalid.
  87.  
  88.           MMMMrrrrmmmmNNNNOOOOTTTT____FFFFOOOOUUUUNNNNDDDD
  89.                     The icon literal was not found in the hierarchy.
  90.  
  91.           MMMMrrrrmmmmWWWWRRRROOOONNNNGGGG____TTTTYYYYPPPPEEEE
  92.                     The caller tried to fetch a literal of a type not
  93.                     supported by this function.
  94.  
  95.           MMMMrrrrmmmmFFFFAAAAIIIILLLLUUUURRRREEEE
  96.                     The function failed.
  97.  
  98.      RRRREEEELLLLAAAATTTTEEEEDDDD
  99.           MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll(3), MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy(3),
  100.           MMMMrrrrmmmmFFFFeeeettttcccchhhhLLLLiiiitttteeeerrrraaaallll(3), MMMMrrrrmmmmFFFFeeeettttcccchhhhCCCCoooolllloooorrrrLLLLiiiitttteeeerrrraaaallll(3), and
  101.           XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy(3).
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.